Add jsdoc bundle package
#10
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
(cherry picked from commit cb88933) Co-authored-by: Miguel Perez Pellicer <[email protected]>
as npm fails to resolve shelljs dependency.
from `-tracking-jsdoc`. It has nothing to do with Tracking, it's just our code convention.
as it is not implemented.
from the `-jsdoc` readme. The plugin should be already installed given the budnle is.
puntope
reviewed
Jun 7, 2022
| * Internal dependencies | ||
| */ | ||
| import { shell } from '../utils.js' | ||
| process.env.PATH += ( path.delimiter + path.join( process.cwd(), 'node_modules', '.bin') ); |
There was a problem hiding this comment.
This line is repeated over all the bin files, so I guess could be reuse it in utils.js kinda file.
There was a problem hiding this comment.
In all 2 ;) We cannot.
as npm fails to resolve shelljs dependency in a parent folder without its own package.json
9914196
Plus it's single line
/**
* Internal dependencies
*/
import { shell } from '../../utils.js'vs.
import shell from 'shelljs';
import path from 'path';
process.env.PATH += ( path.delimiter + path.join( process.cwd(), 'node_modules', '.bin') );So not a big difference in LOC, and a bit more explicit, that it's just the original shelljs
|
When I ran the installation I got this error: |
instead of relative FS path, to make the `jsdoc` package installable elsewhere. Related to #5 Address #10 (comment)
Thanks, it was a leftover from my local testing with a relative filesystem reference. Fixed in 8b88bfd |
|
@puntope would you mind another look? |
puntope
approved these changes
Jun 8, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes proposed in this Pull Request:
Addresses some of the concerns from #6 (review)
Bundles multiple commonly used
jsdocplugins, so the extensions repo would need only this one dependency.Exports a binary, that wraps commonly used
jsdocCLI arguments, for easier use.Screenshots:
Detailed test instructions:
See example usage at woocommerce/google-listings-and-ads@develop...tweak/bundled-jsdoc
And the installation & usage instructions at https://github.com/woocommerce/grow/blob/add/jsdoc-bundle/packages/js/jsdoc/README.md
npm i --save-dev https://gitpkg.now.sh/woocommerce/grow/packages/js/jsdoc?add/jsdoc-bundleTRACKING.mdfile.jsdocrc.json{ "plugins": [ "woocommerce-grow-jsdoc/tilde-alias", "woocommerce-grow-tracking-jsdoc/fires-description", "jsdoc-plugin-typescript", "jsdoc-advanced-types-plugin", "jsdoc-plugin-intersection" ], "typescript": { "moduleRoot": "js/src" } }npx woocommerce-grow-jsdocAdditional details:
Changelog entry